answerrocket-client 0.2.103__tar.gz → 0.2.105__tar.gz

{answerrocket_client-0.2.103 → answerrocket_client-0.2.105}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: answerrocket-client
-Version: 0.2.103
+Version: 0.2.105
 Summary: Python client for interacting with AnswerRocket's skill API
 Requires-Python: >=3.10.7
 Description-Content-Type: text/markdown

{answerrocket_client-0.2.103 → answerrocket_client-0.2.105}/answer_rocket/__init__.py

@@ -5,7 +5,7 @@ __all__ = [
     'MetaDataFrame'
 ]
 
-__version__ = "0.2.103"
+__version__ = "0.2.105"
 
 from answer_rocket.client import AnswerRocketClient
 from answer_rocket.error import AnswerRocketClientError

{answerrocket_client-0.2.103 → answerrocket_client-0.2.105}/answer_rocket/client.py

@@ -11,7 +11,6 @@ from answer_rocket.llm import Llm
 from answer_rocket.layouts import DynamicLayouts
 from answer_rocket.email import Email
 
-
 class AnswerRocketClient:
 	"""
 	Main client for interacting with AnswerRocket services.

{answerrocket_client-0.2.103 → answerrocket_client-0.2.105}/answer_rocket/data.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass, field
-from typing import Optional, List, Dict
+from typing import Any, Optional, List, Dict
 from uuid import UUID
 
 import pandas as pd
@@ -19,7 +19,7 @@ from answer_rocket.graphql.schema import UUID as GQL_UUID, GenerateVisualization
     Metric, Dataset, DatasetDataInterval, Database, DatabaseSearchInput, PagingInput, PagedDatabases, \
     DatabaseTableSearchInput, PagedDatabaseTables, CreateDatasetFromTableResponse, DatasetSearchInput, PagedDatasets, \
     DatabaseKShotSearchInput, PagedDatabaseKShots, DatabaseKShot, CreateDatabaseKShotResponse, \
-    DatasetKShotSearchInput, PagedDatasetKShots, DatasetKShot, CreateDatasetKShotResponse
+    DatasetKShotSearchInput, PagedDatasetKShots, DatasetKShot, CreateDatasetKShotResponse, TrackedDimensionAttribute, TrackedDimensionValuesPage
 from answer_rocket.graphql.sdk_operations import Operations
 from answer_rocket.types import MaxResult, RESULT_EXCEPTION_CODE
 
@@ -2447,3 +2447,90 @@ class Data:
         result = self._gql_client.submit(op, mutation_args)
 
         return result.update_dataset_kshot_visualization
+    
+    def get_tracked_dimension_values(
+        self, dataset_id: UUID
+    ) -> List[TrackedDimensionAttribute]:
+        """
+        Get currently-active starred values for the calling user on a dataset,
+        grouped by dimension.
+
+        Parameters
+        ----------
+        dataset_id : UUID
+            Dataset the starred values belong to.
+
+        Returns
+        -------
+        List[TrackedDimensionAttribute]
+            One entry per dimension the caller has stars in. Each entry exposes
+            ``dimension_attribute_id``, ``dimension_name``, and ``values``
+            (currently-active starred values for that dimension).
+
+        Examples
+        --------
+        >>> attrs = max.tracked_values.get_tracked_dimension_values(
+        ...     dataset_id=uuid.UUID("...")
+        ... )
+        >>> for attr in attrs:
+        ...     print(attr.dimension_name, attr.values)
+        """
+        query_args = {"datasetId": str(dataset_id)}
+        op = Operations.query.get_tracked_dimension_values
+        result = self._gql_client.submit(op, query_args)
+        return result.get_tracked_dimension_values
+
+    def get_all_tracked_dimension_values(
+        self,
+        offset: int = 0,
+        limit: int = 100,
+        dataset_id: Optional[UUID] = None,
+        filters: Optional[dict] = None,
+        sort: Optional[list] = None,
+    ) -> TrackedDimensionValuesPage:
+        """
+        Get a flat, paginated view of tracked values. Admins see every user's
+        rows; non-admins see only their own.
+
+        Parameters
+        ----------
+        offset : int, default 0
+            Zero-based offset for paging.
+        limit : int, default 100
+            Max rows to return.
+        dataset_id : UUID, optional
+            If provided, scope results to a single dataset.
+        filters : dict, optional
+            AG-Grid filterModel JSON (per-column filters). Keys are column ids
+            (e.g. ``"userName"``, ``"value"``, ``"addedUtc"``); values follow
+            AG-Grid's text/set/date filter shapes.
+        sort : list, optional
+            AG-Grid sortModel JSON (list of ``{"colId": ..., "sort": "asc" |
+            "desc", "sortIndex": ...}`` entries).
+
+        Returns
+        -------
+        TrackedDimensionValuesPage
+            Object with ``total_count`` (count after filters but before paging)
+            and ``rows`` (the requested page of joined user/dataset rows).
+
+        Examples
+        --------
+        >>> page = max.tracked_values.get_all_tracked_dimension_values(
+        ...     dataset_id=uuid.UUID("..."),
+        ...     limit=500,
+        ... )
+        >>> print(page.total_count)
+        >>> for row in page.rows:
+        ...     print(row.user_name, row.dimension_name, row.value)
+        """
+        query_args: dict[str, Any] = {
+            "offset": offset,
+            "limit": limit,
+            "datasetId": str(dataset_id) if dataset_id is not None else None,
+            "filters": filters,
+            "sort": sort,
+        }
+        op = Operations.query.get_all_tracked_dimension_values
+        result = self._gql_client.submit(op, query_args)
+        return result.get_all_tracked_dimension_values

{answerrocket_client-0.2.103 → answerrocket_client-0.2.105}/answer_rocket/graphql/schema.py

@@ -240,12 +240,13 @@ class PagingInput(sgqlc.types.Input):
 ########################################################################
 class DomainArtifact(sgqlc.types.Interface):
     __schema__ = schema
-    __field_names__ = ('id', 'name', 'description', 'output_label', 'is_active', 'misc_info')
+    __field_names__ = ('id', 'name', 'description', 'output_label', 'is_active', 'hide_from_user', 'misc_info')
     id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name='id')
     name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name='name')
     description = sgqlc.types.Field(String, graphql_name='description')
     output_label = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name='outputLabel')
     is_active = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name='isActive')
+    hide_from_user = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name='hideFromUser')
     misc_info = sgqlc.types.Field(String, graphql_name='miscInfo')
 
 
@@ -1695,7 +1696,7 @@ class ParameterDefinition(sgqlc.types.Type):
 
 class Query(sgqlc.types.Type):
     __schema__ = schema
-    __field_names__ = ('ping', 'current_user', 'get_copilot_skill_artifact_by_path', 'get_copilots', 'get_copilot_info', 'get_copilot_skill', 'run_copilot_skill', 'get_skill_components', 'get_copilot_hydrated_reports', 'get_async_skill_run_status', 'get_copilot_test_run', 'get_paged_copilot_test_runs', 'get_copilot_question_folders', 'get_max_agent_workflow', 'execute_sql_query', 'execute_rql_query', 'get_databases', 'get_database', 'get_database_tables', 'get_dataset_id', 'get_dataset', 'get_dataset2', 'get_datasets', 'get_domain_object', 'get_domain_object_by_name', 'get_grounded_value', 'get_database_kshots', 'get_database_kshot_by_id', 'get_dataset_kshots', 'get_dataset_kshot_by_id', 'run_max_sql_gen', 'run_sql_ai', 'generate_visualization', 'llmapi_config_for_sdk', 'generate_embeddings', 'get_max_llm_prompt', 'user_chat_threads', 'user_chat_entries', 'chat_thread', 'chat_entry', 'user', 'all_chat_entries', 'skill_memory', 'chat_completion', 'narrative_completion', 'narrative_completion_with_prompt', 'sql_completion', 'research_completion', 'chat_completion_with_prompt', 'research_completion_with_prompt', 'get_chat_artifact', 'get_chat_artifacts', 'get_dynamic_layout')
+    __field_names__ = ('ping', 'current_user', 'get_copilot_skill_artifact_by_path', 'get_copilots', 'get_copilot_info', 'get_copilot_skill', 'run_copilot_skill', 'get_skill_components', 'get_copilot_hydrated_reports', 'get_async_skill_run_status', 'get_copilot_test_run', 'get_paged_copilot_test_runs', 'get_copilot_question_folders', 'get_max_agent_workflow', 'execute_sql_query', 'execute_rql_query', 'get_databases', 'get_database', 'get_database_tables', 'get_dataset_id', 'get_dataset', 'get_dataset2', 'get_datasets', 'get_domain_object', 'get_domain_object_by_name', 'get_grounded_value', 'get_database_kshots', 'get_database_kshot_by_id', 'get_dataset_kshots', 'get_dataset_kshot_by_id', 'run_max_sql_gen', 'run_sql_ai', 'generate_visualization', 'llmapi_config_for_sdk', 'generate_embeddings', 'get_max_llm_prompt', 'user_chat_threads', 'user_chat_entries', 'chat_thread', 'chat_entry', 'user', 'all_chat_entries', 'skill_memory', 'chat_completion', 'narrative_completion', 'narrative_completion_with_prompt', 'sql_completion', 'research_completion', 'chat_completion_with_prompt', 'research_completion_with_prompt', 'get_chat_artifact', 'get_chat_artifacts', 'get_dynamic_layout', 'get_tracked_dimension_values', 'get_all_tracked_dimension_values')
     ping = sgqlc.types.Field(String, graphql_name='ping')
     current_user = sgqlc.types.Field(MaxUser, graphql_name='currentUser')
     get_copilot_skill_artifact_by_path = sgqlc.types.Field(CopilotSkillArtifact, graphql_name='getCopilotSkillArtifactByPath', args=sgqlc.types.ArgDict((
@@ -1976,6 +1977,18 @@ class Query(sgqlc.types.Type):
         ('id', sgqlc.types.Arg(sgqlc.types.non_null(UUID), graphql_name='id', default=None)),
 ))
     )
+    get_tracked_dimension_values = sgqlc.types.Field(sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null('TrackedDimensionAttribute'))), graphql_name='getTrackedDimensionValues', args=sgqlc.types.ArgDict((
+        ('dataset_id', sgqlc.types.Arg(sgqlc.types.non_null(UUID), graphql_name='datasetId', default=None)),
+))
+    )
+    get_all_tracked_dimension_values = sgqlc.types.Field(sgqlc.types.non_null('TrackedDimensionValuesPage'), graphql_name='getAllTrackedDimensionValues', args=sgqlc.types.ArgDict((
+        ('offset', sgqlc.types.Arg(Int, graphql_name='offset', default=0)),
+        ('limit', sgqlc.types.Arg(Int, graphql_name='limit', default=100)),
+        ('dataset_id', sgqlc.types.Arg(UUID, graphql_name='datasetId', default=None)),
+        ('filters', sgqlc.types.Arg(JSON, graphql_name='filters', default=None)),
+        ('sort', sgqlc.types.Arg(JSON, graphql_name='sort', default=None)),
+))
+    )
 
 
 class RunMaxSqlGenResponse(sgqlc.types.Type):
@@ -2053,6 +2066,37 @@ class SkillParameter(sgqlc.types.Type):
     match_values = sgqlc.types.Field(MatchValues, graphql_name='matchValues')
 
 
+class TrackedDimensionAttribute(sgqlc.types.Type):
+    __schema__ = schema
+    __field_names__ = ('dimension_attribute_id', 'dimension_name', 'values')
+    dimension_attribute_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name='dimensionAttributeId')
+    dimension_name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name='dimensionName')
+    values = sgqlc.types.Field(sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))), graphql_name='values')
+
+
+class TrackedDimensionValueRow(sgqlc.types.Type):
+    __schema__ = schema
+    __field_names__ = ('watch_set_id', 'user_id', 'user_name', 'user_email', 'dataset_id', 'dataset_name', 'dimension_attribute_id', 'dimension_name', 'value', 'added_utc', 'last_modified_utc')
+    watch_set_id = sgqlc.types.Field(sgqlc.types.non_null(UUID), graphql_name='watchSetId')
+    user_id = sgqlc.types.Field(sgqlc.types.non_null(UUID), graphql_name='userId')
+    user_name = sgqlc.types.Field(String, graphql_name='userName')
+    user_email = sgqlc.types.Field(String, graphql_name='userEmail')
+    dataset_id = sgqlc.types.Field(sgqlc.types.non_null(UUID), graphql_name='datasetId')
+    dataset_name = sgqlc.types.Field(String, graphql_name='datasetName')
+    dimension_attribute_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name='dimensionAttributeId')
+    dimension_name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name='dimensionName')
+    value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name='value')
+    added_utc = sgqlc.types.Field(DateTime, graphql_name='addedUtc')
+    last_modified_utc = sgqlc.types.Field(DateTime, graphql_name='lastModifiedUtc')
+
+
+class TrackedDimensionValuesPage(sgqlc.types.Type):
+    __schema__ = schema
+    __field_names__ = ('rows', 'total_count')
+    rows = sgqlc.types.Field(sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(TrackedDimensionValueRow))), graphql_name='rows')
+    total_count = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name='totalCount')
+
+
 class UserGroup(sgqlc.types.Type):
     __schema__ = schema
     __field_names__ = ('user_group_id', 'name')
@@ -2062,25 +2106,27 @@ class UserGroup(sgqlc.types.Type):
 
 class AzureOpenaiCompletionLLMApiConfig(sgqlc.types.Type, LLMApiConfig):
     __schema__ = schema
-    __field_names__ = ('api_base_url', 'api_version', 'openai_model_name', 'max_tokens_input', 'max_tokens_content_generation', 'temperature', 'top_p', 'presence_penalty', 'frequency_penalty', 'cost_per_model_input_unit', 'cost_per_model_output_unit')
+    __field_names__ = ('api_base_url', 'api_version', 'openai_model_name', 'max_tokens_input', 'max_tokens_content_generation', 'temperature', 'top_p', 'presence_penalty', 'frequency_penalty', 'cost_per_model_input_unit', 'cost_per_model_output_unit', 'use_apim_auth')
     api_base_url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name='apiBaseUrl')
     api_version = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name='apiVersion')
     openai_model_name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name='openaiModelName')
     max_tokens_input = sgqlc.types.Field(Int, graphql_name='maxTokensInput')
     max_tokens_content_generation = sgqlc.types.Field(Int, graphql_name='maxTokensContentGeneration')
-    temperature = sgqlc.types.Field(sgqlc.types.non_null(Float), graphql_name='temperature')
-    top_p = sgqlc.types.Field(sgqlc.types.non_null(Float), graphql_name='topP')
-    presence_penalty = sgqlc.types.Field(sgqlc.types.non_null(Float), graphql_name='presencePenalty')
-    frequency_penalty = sgqlc.types.Field(sgqlc.types.non_null(Float), graphql_name='frequencyPenalty')
+    temperature = sgqlc.types.Field(Float, graphql_name='temperature')
+    top_p = sgqlc.types.Field(Float, graphql_name='topP')
+    presence_penalty = sgqlc.types.Field(Float, graphql_name='presencePenalty')
+    frequency_penalty = sgqlc.types.Field(Float, graphql_name='frequencyPenalty')
     cost_per_model_input_unit = sgqlc.types.Field(Float, graphql_name='costPerModelInputUnit')
     cost_per_model_output_unit = sgqlc.types.Field(Float, graphql_name='costPerModelOutputUnit')
+    use_apim_auth = sgqlc.types.Field(Boolean, graphql_name='useApimAuth')
 
 
 class AzureOpenaiEmbeddingLLMApiConfig(sgqlc.types.Type, LLMApiConfig):
     __schema__ = schema
-    __field_names__ = ('api_base_url', 'api_version')
+    __field_names__ = ('api_base_url', 'api_version', 'use_apim_auth')
     api_base_url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name='apiBaseUrl')
     api_version = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name='apiVersion')
+    use_apim_auth = sgqlc.types.Field(Boolean, graphql_name='useApimAuth')
 
 
 class Dimension(sgqlc.types.Type, DomainArtifact):
@@ -2180,10 +2226,10 @@ class OpenaiCompletionLLMApiConfig(sgqlc.types.Type, LLMApiConfig):
     __field_names__ = ('organization', 'max_tokens_content_generation', 'temperature', 'top_p', 'presence_penalty', 'frequency_penalty', 'cost_per_model_input_unit', 'cost_per_model_output_unit')
     organization = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name='organization')
     max_tokens_content_generation = sgqlc.types.Field(Int, graphql_name='maxTokensContentGeneration')
-    temperature = sgqlc.types.Field(sgqlc.types.non_null(Float), graphql_name='temperature')
-    top_p = sgqlc.types.Field(sgqlc.types.non_null(Float), graphql_name='topP')
-    presence_penalty = sgqlc.types.Field(sgqlc.types.non_null(Float), graphql_name='presencePenalty')
-    frequency_penalty = sgqlc.types.Field(sgqlc.types.non_null(Float), graphql_name='frequencyPenalty')
+    temperature = sgqlc.types.Field(Float, graphql_name='temperature')
+    top_p = sgqlc.types.Field(Float, graphql_name='topP')
+    presence_penalty = sgqlc.types.Field(Float, graphql_name='presencePenalty')
+    frequency_penalty = sgqlc.types.Field(Float, graphql_name='frequencyPenalty')
     cost_per_model_input_unit = sgqlc.types.Field(Float, graphql_name='costPerModelInputUnit')
     cost_per_model_output_unit = sgqlc.types.Field(Float, graphql_name='costPerModelOutputUnit')
 

{answerrocket_client-0.2.103 → answerrocket_client-0.2.105}/answer_rocket/graphql/sdk_operations.py

@@ -1247,6 +1247,34 @@ def query_current_user():
     return _op
 
 
+def query_get_tracked_dimension_values():
+    _op = sgqlc.operation.Operation(_schema_root.query_type, name='GetTrackedDimensionValues', variables=dict(datasetId=sgqlc.types.Arg(sgqlc.types.non_null(_schema.UUID))))
+    _op_get_tracked_dimension_values = _op.get_tracked_dimension_values(dataset_id=sgqlc.types.Variable('datasetId'))
+    _op_get_tracked_dimension_values.dimension_attribute_id()
+    _op_get_tracked_dimension_values.dimension_name()
+    _op_get_tracked_dimension_values.values()
+    return _op
+
+
+def query_get_all_tracked_dimension_values():
+    _op = sgqlc.operation.Operation(_schema_root.query_type, name='GetAllTrackedDimensionValues', variables=dict(offset=sgqlc.types.Arg(_schema.Int), limit=sgqlc.types.Arg(_schema.Int), datasetId=sgqlc.types.Arg(_schema.UUID), filters=sgqlc.types.Arg(_schema.JSON), sort=sgqlc.types.Arg(_schema.JSON)))
+    _op_get_all_tracked_dimension_values = _op.get_all_tracked_dimension_values(offset=sgqlc.types.Variable('offset'), limit=sgqlc.types.Variable('limit'), dataset_id=sgqlc.types.Variable('datasetId'), filters=sgqlc.types.Variable('filters'), sort=sgqlc.types.Variable('sort'))
+    _op_get_all_tracked_dimension_values.total_count()
+    _op_get_all_tracked_dimension_values_rows = _op_get_all_tracked_dimension_values.rows()
+    _op_get_all_tracked_dimension_values_rows.watch_set_id()
+    _op_get_all_tracked_dimension_values_rows.user_id()
+    _op_get_all_tracked_dimension_values_rows.user_name()
+    _op_get_all_tracked_dimension_values_rows.user_email()
+    _op_get_all_tracked_dimension_values_rows.dataset_id()
+    _op_get_all_tracked_dimension_values_rows.dataset_name()
+    _op_get_all_tracked_dimension_values_rows.dimension_attribute_id()
+    _op_get_all_tracked_dimension_values_rows.dimension_name()
+    _op_get_all_tracked_dimension_values_rows.value()
+    _op_get_all_tracked_dimension_values_rows.added_utc()
+    _op_get_all_tracked_dimension_values_rows.last_modified_utc()
+    return _op
+
+
 class Query:
     all_chat_entries = query_all_chat_entries()
     chat_completion = query_chat_completion()
@@ -1256,6 +1284,7 @@ class Query:
     current_user = query_current_user()
     dataframes_for_entry = query_dataframes_for_entry()
     generate_embeddings = query_generate_embeddings()
+    get_all_tracked_dimension_values = query_get_all_tracked_dimension_values()
     get_async_skill_run_status = query_get_async_skill_run_status()
     get_chat_artifact = query_get_chat_artifact()
     get_chat_artifacts = query_get_chat_artifacts()
@@ -1279,6 +1308,7 @@ class Query:
     get_max_agent_workflow = query_get_max_agent_workflow()
     get_max_llm_prompt = query_get_max_llm_prompt()
     get_paged_copilot_test_runs = query_get_paged_copilot_test_runs()
+    get_tracked_dimension_values = query_get_tracked_dimension_values()
     narrative_completion = query_narrative_completion()
     narrative_completion_with_prompt = query_narrative_completion_with_prompt()
     research_completion = query_research_completion()

{answerrocket_client-0.2.103 → answerrocket_client-0.2.105}/answerrocket_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: answerrocket-client
-Version: 0.2.103
+Version: 0.2.105
 Summary: Python client for interacting with AnswerRocket's skill API
 Requires-Python: >=3.10.7
 Description-Content-Type: text/markdown