From 95c77e8858bdbbf3e8522816953d65c26b21afd0 Mon Sep 17 00:00:00 2001 From: Visier-Build-Team Date: Fri, 9 Aug 2024 17:06:33 +0000 Subject: [PATCH] Updating Definitions --- res/administration-apis.yaml | 24 +- res/analytic-model-apis.yaml | 2 +- res/authentication-apis.yaml | 3 +- res/data-in-apis.yaml | 189 +--------------- res/data-out-apis.yaml | 418 +++++++++++++++++++++-------------- 5 files changed, 282 insertions(+), 354 deletions(-) diff --git a/res/administration-apis.yaml b/res/administration-apis.yaml index 9503cb8..efd6695 100644 --- a/res/administration-apis.yaml +++ b/res/administration-apis.yaml @@ -8,7 +8,7 @@ info: license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 - version: 22222222.99201.1435 + version: 22222222.99201.1436 paths: /v1/admin/capabilities: get: @@ -2448,10 +2448,28 @@ paths: parameters: - name: projectId in: path - description: The unique identifier of the draft project you want to retrieve. required: true schema: type: string + - name: with + in: query + description: |- + The types of draft projects to include in the request response. + * If empty, returns all the `Open` draft projects. + * If `Open`, returns all Open draft projects. + * If `Approval`, returns all draft projects in the approval stage. Changes cannot made in Approval projects. + * If `Rejected`, returns all draft projects that have been rejected. Changes cannot be committed in Rejected projects. + * If `Archived`, returns all draft projects that have been archived. Changes cannot be committed in Archived projects. + schema: + type: array + items: + type: string + - name: limit + in: query + description: The number of projects to return per type. The maximum number of projects to retrieve per type is 1000. The default is 100. + schema: + type: integer + format: int32 responses: "200": description: OK @@ -4352,7 +4370,7 @@ components: format: uint32 start: type: integer - description: The index of the tenant to start retrieving results from, also known as offset. The index begins at 0. + description: The index to start retrieving results from, also known as offset. The index begins at 0. format: uint32 description: Users that are assigned a specific permission. PermissionBulkOperationResponseDTO: diff --git a/res/analytic-model-apis.yaml b/res/analytic-model-apis.yaml index 4646523..0d78b36 100644 --- a/res/analytic-model-apis.yaml +++ b/res/analytic-model-apis.yaml @@ -8,7 +8,7 @@ info: license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 - version: 22222222.99201.1435 + version: 22222222.99201.1436 paths: /v1/admin/calculation-concepts: get: diff --git a/res/authentication-apis.yaml b/res/authentication-apis.yaml index f0b0fba..67aa70a 100644 --- a/res/authentication-apis.yaml +++ b/res/authentication-apis.yaml @@ -8,7 +8,7 @@ info: license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 - version: 22222222.99201.1435 + version: 22222222.99201.1436 paths: /v1/auth/oauth2/userinfo: get: @@ -240,7 +240,6 @@ components: - ReportDownloading - PlutoUser - ReportingManagement - - QuotaManagement type: string format: enum accessLevel: diff --git a/res/data-in-apis.yaml b/res/data-in-apis.yaml index 198f271..ed2bee2 100644 --- a/res/data-in-apis.yaml +++ b/res/data-in-apis.yaml @@ -8,7 +8,7 @@ info: license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 - version: 22222222.99201.1435 + version: 22222222.99201.1436 paths: /v1/data/directloads/{draftId}/configs: get: @@ -1269,180 +1269,6 @@ paths: application/json: schema: $ref: '#/components/schemas/Status' - /v1alpha/op/jobs/consolidated-analytics-jobs: - post: - tags: - - DataAndJobHandling - summary: Run a consolidated analytics job - description: Run a job for a consolidated analytics tenant. This request retrieves data for all source tenants in a consolidated analytics tenant. After the job completes, you can run a processing job to generate a data version for the consolidated analytics tenant. To run a processing job, see `POST /v1alpha/op/jobs/processing-jobs`. - operationId: DataAndJobHandling_AdhocConsolidatedAnalyticsJob - parameters: - - name: tenantCode - in: query - description: The tenant code of the consolidated analytics tenant; for example, "WFF_j1r~CAa7s". - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/JobIdResponse' - default: - description: Default error response - content: - application/json: - schema: - $ref: '#/components/schemas/Status' - /v1alpha/op/jobs/extraction-jobs: - post: - tags: - - DataAndJobHandling - summary: Run a data connector extraction job - description: |- - Run an extraction job to retrieve data through a Visier data connector and generate a new data version. Administrating tenants can run extraction jobs for all analytic tenants, a list of analytic tenants, or the administrating tenant. - If running extraction jobs for an administating tenant or their analytic tenants, this request starts a dispatching job that generates one extraction job per tenant. The response returns the job ID of the extraction job or dispatching job. - operationId: DataAndJobHandling_AdhocExtractionJob - parameters: - - name: tenants - in: query - description: The unique IDs of the tenants to run an extraction job for. - schema: - type: array - items: - type: string - - name: allTenants - in: query - description: If "true", runs an extraction job for all tenants and ignores the tenants field. - schema: - type: boolean - - name: overrideLastExtractionTimestamp - in: query - description: An epoch timestamp in milliseconds from which to retrieve data. This overrides the last extraction date to retrieve more data. - schema: - type: string - - name: publishDataLoadArtifacts - in: query - description: If "true", publishes the project to production. - schema: - type: boolean - - name: runProcessingJob - in: query - description: If "true", runs a processing job to generate a data version after the extraction job succeeds. - schema: - type: boolean - - name: dataCategoryId - in: query - description: The unique ID of the data category in which to generate objects. - schema: - type: string - - name: disableArtifactGeneration - in: query - description: If "true", doesn't generate objects after the extraction jobs succeeds. - schema: - type: boolean - - name: connectorIds - in: query - description: The unique IDs of the connectors to run extraction jobs for. - schema: - type: array - items: - type: string - - name: lastExtractionTimeOffsetWeeks - in: query - description: The number of weeks from which to retrieve data. This overrides the last extraction date to retrieve more data. - schema: - type: integer - format: int32 - - name: monthsToExtract - in: query - description: The number of months to retrieve snapshot data from. - schema: - type: integer - format: int32 - - name: extractToTimeOverride - in: query - description: An epoch timestamp in milliseconds for the end time up to which to retrieve data. - schema: - type: string - - name: batchSizeOverride - in: query - description: The maximum amount of IDs the job can retrieve in each batch. - schema: - type: integer - format: int32 - - name: sqlBatchSize - in: query - description: The maximum amount of SQL table records the job can retrieve in each batch. - schema: - type: integer - format: int32 - - name: forceUpdateExistingArtifacts - in: query - description: If "true" and `disableArtifactGeneration` is "false", updates extractor artifacts, which may overwrite the artifacts' manual overrides. Ignored if `disableArtifactGeneration` is "true". - schema: - type: boolean - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/JobIdResponse' - default: - description: Default error response - content: - application/json: - schema: - $ref: '#/components/schemas/Status' - /v1alpha/op/jobs/processing-jobs: - post: - tags: - - DataAndJobHandling - summary: Run a processing job - description: |- - Run a processing job to generate a new data version. Administrating tenants can run processing jobs for all analytic tenants, a list of analytic tenants, or the administrating tenant. - If running processing jobs for an administating tenant or their analytic tenants, this request starts a dispatching job that generates one processing job per tenant. The response returns the job ID of the processing job or dispatching job. - operationId: DataAndJobHandling_AdhocProcessingJobs - parameters: - - name: tenants - in: query - description: The tenant codes of the tenants to run processing jobs for. If omitted, runs a processing job for the tenant associated with the user who made the API request. - schema: - type: array - items: - type: string - - name: allTenants - in: query - description: If `true`, runs processing jobs for all accessible analytic tenants. Default is `false`. - schema: - type: boolean - - name: dataCategoryId - in: query - description: |- - The unique identifier of the data category to run the job. If omitted, runs a job using the primary data category. - To retrieve a list of all data categories, see `GET /v1/op/data/categories`. - schema: - type: string - - name: publishToProduction - in: query - description: If `true`, publishes the generated data version to production. Default is `false`. - schema: - type: boolean - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/JobIdResponse' - default: - description: Default error response - content: - application/json: - schema: - $ref: '#/components/schemas/Status' /v1/data/directloads/{draftId}/transactions/{transactionId}/{objectName}: put: tags: @@ -1755,17 +1581,13 @@ components: type: array items: $ref: '#/components/schemas/DataCategoryResponseDTO' - description: A list of data categories. DataCategoryResponseDTO: type: object properties: name: type: string - description: The display name of the data category. id: type: string - description: The UUID of the data category. - description: The data category's UUID and display name. DataLoadRequest: type: object properties: @@ -2412,15 +2234,6 @@ components: items: $ref: '#/components/schemas/JobCancellationResultDTO' description: A list of objects representing the job cancellation results. - JobIdResponse: - type: object - properties: - jobId: - type: string - description: |- - * @exclude - Response for requests with `jobId` as key to maintain compatibility with legacy APIs. - Future APIs returning a UUID should return `UUIDResponse`. JobStatusListResponse: type: object properties: diff --git a/res/data-out-apis.yaml b/res/data-out-apis.yaml index 1008ef8..6e427b4 100644 --- a/res/data-out-apis.yaml +++ b/res/data-out-apis.yaml @@ -8,7 +8,7 @@ info: license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 - version: 22222222.99201.1435 + version: 22222222.99201.1436 paths: /v1/data/query/aggregate: post: @@ -307,159 +307,238 @@ paths: application/json: schema: $ref: '#/components/schemas/DvExportStatus' - /v1alpha/rest/vee/feedback: + /v1alpha/rest/vee/query: post: tags: - - Vee - summary: Submit Vee feedback + - VeeQuery + summary: Ask Vee a question description: |- - Give Vee feedback for a previous answer. To submit feedback, include: - * The response object from the `/question` response. - * A rating of Vee's answer. If `isApproved` is `true`, Vee answered the question correctly. If `isApproved` is `false`, Vee's answer was incorrect or lacked details. - * A description of how Vee should have answered the question or how Vee can improve the answer, such as "Expected Headcount metric, but Vee returned Average Headcount". + Use this API to ask Vee a People Analytic question and receive a response. + Options `includeData` and `includeVisual` can be set in the request data to receive additional data corresponding to the answer. + [ Example 1 ] initiating a conversation with Vee: `POST v1alpha/rest/vee/query` with body data + ```json + { + "question": "what is the headcount by gender in each org?", + "options": { + "includeVisual": "true", + "includeData": "true", + "rewordedQuestion": "true" + } + } + ``` + returns + ```json + { + "threadState": { + "questionState": [ + "(encrypted threadState string)" + ] + }, + "statusCode": { + "statusCode": "VEE_API_SUCCESS", + "statusMsg": "Successful Vee response for question=what is the headcount by gender in each org?" + }, + "narrative": "In Apr 2024, the Headcount: for Man & Operations was the largest at 165 (16.1% of total) and for Woman & BlueSphere was the smallest at 1 (0.1% of total).", + "chartUrl": "http://(vanity).visier.com/hr/prod/appcontainer#/analytics/queryFnChart?fn=(chartPath)", + "schema": { + "metrics": [ + "Headcount" + ], + "dimensions": [ + { + "name": "Organization" + }, + { + "name": "Gender" + }, + { + "name": "Gender", + "paths": [ + "Employee" + ] + }, + { + "name": "Organization", + "paths": [ + "Employee" + ] + } + ] + }, + "data": { + "dataJson": "(hidden for length)", + "context": "{\"filters\":[],\"timeFilter\":[\"Apr 2024\"]}" + , + "visual": { + "image": "(base64 encoded PNG of rasterized chart)" + "title": "Trend of Average Hourly Rate by Gender", + "context": "{\"filters\":[],\"timeFilter\":[\"Apr 2024\"]}" + }, + "rewordedQuestion": "What is the gender breakdown of our workforce by organization this month?" + } + ``` + + [ Example 2 ] Asking Vee a followup question: `POST v1alpha/rest/vee/query` with body data: + ```json + { + "question": "what about by tenure?", + "threadState": { + "questionState": [ + "(valueof_questionState_from_Example_1_above)" + ] + }, + "options": { + "includeVisual": "false", + "includeData": "true", + "rewordedQuestion": "false" + } + } + ```` + returns + ```json + { + "threadState": { + "questionState": [ + "(valueof_questionState_from_Example_1_above)", + "(new encrypted threadState string)" + ] + }, + "statusCode": { + "statusCode": "VEE_API_SUCCESS", + "statusMsg": "Successful Vee response for question=what about by tenure?" + }, + "narrative": "In Apr 2024, the Headcount by Tenure Range were: 0 to 1 yr was 205 (20% of total), 1 to 2 yrs was 121 (11.8% of total) and 2 to 3 yrs was 91 (8.86% of total)and 4 more.", + "chartUrl": "http://(vanity).visier.com/hr/prod/appcontainer#/analytics/queryFnChart?fn=(chartPath)", + "schema": { + "metrics": [ + "Headcount" + ], + "dimensions": [ + { + "name": "Tenure Range" + }, + { + "name": "Tenure Range", + "paths": [ + "Employee" + ] + } + ] + }, + "data": { + "dataJson": "(hidden)", + "context": "{\"filters\":[],\"timeFilter\":[\"Apr 2024\"]}" + } + } + ```
**Note:** This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM). - operationId: Vee_VeeFeedback + operationId: VeeQuery_VeeQueryRequest parameters: - - name: response.conversationState.questionState - in: query - description: The unique identifier of the conversation with Vee. - schema: - type: array - items: - type: string - - name: response.statusCode.statusCode - in: query - description: A status code indicating whether or not Vee successfully answered the question. - schema: - enum: - - UNDEFINED - - VEE_API_SUCCESS - - VEE_API_WARNING - - VEE_API_ERROR - type: string - format: enum - - name: response.statusCode.statusMsg - in: query - description: Additional information about whether or not Vee successfully answered the question. - schema: - type: string - - name: response.narrative - in: query - description: Vee's answer to the question. - schema: - type: string - - name: response.chartUrl + - name: question in: query - description: A URL to view the visualization in Visier. schema: type: string - - name: response.schema.metrics + - name: threadState.questionState in: query - description: A list of the metrics that contribute to Vee's answer. schema: type: array items: type: string - - name: response.data.dataJson - in: query - description: A JSON string of fields and numerical values representing the data contributing to Vee's answer. For example, the number of employees per gender in Vee's answer. - schema: - type: string - - name: response.data.context + - name: options.includeVisual in: query - description: The filter applied to the visualization generated by Vee. For example, a time filter of April 2024. schema: - type: string - - name: response.visual.image + type: boolean + - name: options.chartOptions.width in: query - description: A PNG visualization encoded in a base64 string. schema: - type: string - - name: response.visual.title + type: integer + format: uint32 + - name: options.chartOptions.height in: query - description: The visualization title. schema: - type: string - - name: response.visual.context + type: integer + format: uint32 + - name: options.includeData in: query - description: Any filters applied to the visualization. For example, a time filter of April 2024. schema: - type: string - - name: response.rewordedQuestion + type: boolean + - name: options.dataFormat in: query - description: Vee's plain language interpretation of the original question. For example, if you asked "what is the headcount by gender in each org?", Vee might reword the question as "What is the gender breakdown of our workforce by organization this month?". schema: + enum: + - json type: string - - name: isApproved + format: enum + - name: options.includeRewordedQuestion in: query - description: If `true`, Vee answered the question correctly. If `false`, Vee's answer was incorrect or lacked details. schema: type: boolean - - name: description - in: query - description: A description of how Vee should have answered the question or how Vee can improve the answer; for example, "Expected Headcount metric, but Vee returned Average Headcount". - schema: - type: string responses: "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/VeeStatusCodeDTO' + $ref: '#/components/schemas/VeeResponseDTO' default: description: Default error response content: application/json: schema: $ref: '#/components/schemas/Status' - /v1alpha/rest/vee/question: + /v1alpha/rest/vee/query-feedback: post: tags: - - Vee - summary: Ask Vee a question - description: "Use plain language to ask Vee a people question. Use query parameters to specify how Vee should respond, such as returning a visualization, data, or rewording the question.\n \n The response always returns a `conversationState` object containing a unique ID for the conversation. To ask a follow-up question or continue the conversation with Vee, include the `conversationState` from the response in your next `/question` call. To submit feedback about Vee's answer, copy the entire response into your `/feedback` call.\n\n
**Note:** This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM)." - operationId: Vee_VeeQuestionRequest + - VeeQuery + summary: Submit Vee feedback + description: |- + Give Vee feedback on a previous response. POST the JSON response returned from `query` endpoint above, + along with a positive or negative rating (`isApproved`) and any further information you'd like to provide (`description`). + + Example: `POST /v1alpha/rest/vee/query-feedback` returns a success or failure: + ```json + { + "response": { (valueof_json_response_from_query_endpoint) }, + "isApproved": "false", + "description": "I wanted to see more orgs in the answer!" + } + ``` +
**Note:** This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. + If you are interested in using this API, please contact your Customer Success Manager (CSM). + operationId: VeeQuery_VeeQueryFeedback parameters: - name: question in: query - description: The question to ask Vee. If asking a follow-up question or continuing a conversation with Vee, specify the `conversationState` object from the question's response. schema: type: string - - name: conversationState.questionState + - name: threadState.questionState in: query - description: The unique identifier of the conversation with Vee. schema: type: array items: type: string - name: options.includeVisual in: query - description: If `true`, returns a base64 string-encoded PNG of a rendered visualization with Vee's answer. Default is `false`. schema: type: boolean - - name: options.visualOptions.width + - name: options.chartOptions.width in: query - description: The pixel width of the rendered visualization. Default is 600. Valid values are between 160 and 1600. schema: type: integer format: uint32 - - name: options.visualOptions.height + - name: options.chartOptions.height in: query - description: The pixel height of the rendered visualization. Default is 338. Valid values are between 90 and 900. schema: type: integer format: uint32 - name: options.includeData in: query - description: If `true`, returns additional data relevant to the question, including `dataJson` (visualization data) and `context` (filters applied to the visualization). Default is `false`. schema: type: boolean - name: options.dataFormat in: query - description: 'The format to return visualization data in. Valid values: `json`.' schema: enum: - json @@ -467,7 +546,6 @@ paths: format: enum - name: options.includeRewordedQuestion in: query - description: If `true`, returns Vee's plain language interpretation of the original question. For example, if you asked "what is the headcount by gender in each org?", Vee might reword the question as "What is the gender breakdown of our workforce by organization this month?". Default is `false`. schema: type: boolean responses: @@ -476,7 +554,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VeeResponseDTO' + $ref: '#/components/schemas/VeeFeedbackDTO' default: description: Default error response content: @@ -486,10 +564,63 @@ paths: /v1alpha/rest/vee/sample-questions: get: tags: - - Vee - summary: Retrieve a list of sample questions to ask Vee - description: "Get a list of sample questions to help your users start using Vee. The response returns a list of questions, such as \"What is the turnover rate?\". \n\n
**Note:** This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM)." - operationId: Vee_VeeSampleQuestions + - VeeQuery + summary: Get a list of sample questions + description: |- + To get started with Vee, use this API to get a list of sample questions. + Example: `GET /v1alpha/rest/vee/sample-questions` returns a string list of questions. + ```json + questions { + "questions": "What is the turnover rate?" + "metadata": { + "categories": "metricQuestion"" + } + } + ``` + +
**Note:** This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. + If you are interested in using this API, please contact your Customer Success Manager (CSM). + operationId: VeeQuery_VeeSampleQuestions + parameters: + - name: question + in: query + schema: + type: string + - name: threadState.questionState + in: query + schema: + type: array + items: + type: string + - name: options.includeVisual + in: query + schema: + type: boolean + - name: options.chartOptions.width + in: query + schema: + type: integer + format: uint32 + - name: options.chartOptions.height + in: query + schema: + type: integer + format: uint32 + - name: options.includeData + in: query + schema: + type: boolean + - name: options.dataFormat + in: query + schema: + enum: + - json + type: string + format: enum + - name: options.includeRewordedQuestion + in: query + schema: + type: boolean responses: "200": description: OK @@ -1427,6 +1558,11 @@ components: description: |- QueryAxisOptions allows you to customize an axis in the query, such as changing the display mode for its cell set values or providing a custom column name. Only available when the Accept header is a table format, such as text/csv or application/jsonlines. + QueryClarificationDTO: + type: object + properties: + message: + type: string QueryDimensionDataMemberSelectionDTO: type: object properties: @@ -2007,21 +2143,24 @@ components: description: The direction to extend. Default is BACKWARD. format: enum description: The amount of time to shift the time interval by, such as backward by one year. - VeeClarificationDTO: + VeeDataDTO: type: object properties: - message: + dataJson: + type: string + context: type: string - description: If Vee needs more context to answer your question, the follow-up question should address this clarification. - VeeConversationStateDTO: + VeeFeedbackDTO: type: object properties: - questionState: - type: array - items: - type: string - description: The unique identifier of the conversation with Vee. - VeeCorrectionsDTO: + response: + $ref: '#/components/schemas/VeeResponseDTO' + isApproved: + type: boolean + description: + type: string + description: Query feedback DTOs + VeeQueryCorrectionsDTO: type: object properties: warning: @@ -2037,62 +2176,32 @@ components: - VEE_WARNING_FILTER_DROPPED type: string format: enum - description: A list of warnings from Vee that accompanies an unsure answer; for example, Vee might return a close match warning if Vee finds multiple employees named Adam that relate to your question. clarifications: type: array items: - $ref: '#/components/schemas/VeeClarificationDTO' - description: A list of clarifying questions if Vee needs more context to answer your question; for example, if asking about someone named Adam, Vee might clarify which Adam by asking for Adam's email address. - VeeDataDTO: - type: object - properties: - dataJson: - type: string - description: A JSON string of fields and numerical values representing the data contributing to Vee's answer. For example, the number of employees per gender in Vee's answer. - context: - type: string - description: The filter applied to the visualization generated by Vee. For example, a time filter of April 2024. + $ref: '#/components/schemas/QueryClarificationDTO' VeeResponseDTO: type: object properties: - conversationState: - allOf: - - $ref: '#/components/schemas/VeeConversationStateDTO' - description: The current conversation's details. To ask a follow-up question or continue the conversation with Vee, include the `conversationState` from the response in your next `/question` call. To submit feedback about Vee's answer, copy the entire response into your `/feedback` call. + threadState: + $ref: '#/components/schemas/VeeThreadStateDTO' statusCode: - allOf: - - $ref: '#/components/schemas/VeeStatusCodeDTO' - description: A status code indicating whether or not Vee successfully answered the question. + $ref: '#/components/schemas/VeeStatusCodeDTO' narrative: type: string - description: Vee's answer to the question. chartUrl: type: string - description: A URL to view the visualization in Visier. schema: - allOf: - - $ref: '#/components/schemas/VeeResponseSchemaDTO' - description: The metrics, dimensions, and concepts that contribute to Vee's answer. + $ref: '#/components/schemas/VeeResponseSchemaDTO' corrections: - type: array - items: - $ref: '#/components/schemas/VeeCorrectionsDTO' - description: A list of corrections and clarifications if the question was ambiguous or Vee was unsure in the answer. + $ref: '#/components/schemas/VeeQueryCorrectionsDTO' data: - allOf: - - $ref: '#/components/schemas/VeeDataDTO' - description: Returned if `includeData` is `true`. Provides additional data relevant to the question, such as the visualization data and any filters applied to the visualization. + $ref: '#/components/schemas/VeeDataDTO' visual: - allOf: - - $ref: '#/components/schemas/VeeVisualDTO' - description: A base64 string-encoded PNG of a visualization generated by Vee to answer a question. For example, Vee can return a Breakdown visualization if asked about the headcount in each organization. + $ref: '#/components/schemas/VeeVisualDTO' rewordedQuestion: type: string - description: Vee's plain language interpretation of the original question. For example, if you asked "what is the headcount by gender in each org?", Vee might reword the question as "What is the gender breakdown of our workforce by organization this month?". - description: |- - ***************************************** - Server Response DTOs for question endpoint - **************************************** + description: Server Response DTOs VeeResponseSchemaDTO: type: object properties: @@ -2100,38 +2209,31 @@ components: type: array items: type: string - description: A list of the metrics that contribute to Vee's answer. dimensions: type: array items: $ref: '#/components/schemas/VeeResponseSchemaReferenceDTO' - description: A list of the dimensions that contribute to Vee's answer. concepts: type: array items: $ref: '#/components/schemas/VeeResponseSchemaReferenceDTO' - description: A list of the concepts that contribute to Vee's answer. VeeResponseSchemaReferenceDTO: type: object properties: name: type: string - description: The name of an attribute in the visualization; for example, Gender. paths: type: array items: type: string - description: The hierarchy path of an attribute in the visualization; for example, Employee.Gender. VeeSampleQuestionDTO: type: object properties: question: type: string - description: A question in plain language. metadata: - allOf: - - $ref: '#/components/schemas/VeeSampleQuestionMetadataDTO' - description: Details about the sample question, such as what categories the question belongs to. + $ref: '#/components/schemas/VeeSampleQuestionMetadataDTO' + description: Query sample questions VeeSampleQuestionLibraryDTO: type: object properties: @@ -2139,11 +2241,6 @@ components: type: array items: $ref: '#/components/schemas/VeeSampleQuestionDTO' - description: A list of sample questions to help your users start using Vee. - description: |- - *************************************************** - Server Response DTOs for sample-questions endpoint - ************************************************** VeeSampleQuestionMetadataDTO: type: object properties: @@ -2151,7 +2248,6 @@ components: type: array items: type: string - description: A list of topics that the sample question relates to. VeeStatusCodeDTO: type: object properties: @@ -2162,23 +2258,25 @@ components: - VEE_API_WARNING - VEE_API_ERROR type: string - description: A status code indicating whether or not Vee successfully answered the question. format: enum statusMsg: type: string - description: Additional information about whether or not Vee successfully answered the question. + VeeThreadStateDTO: + type: object + properties: + questionState: + type: array + items: + type: string VeeVisualDTO: type: object properties: image: type: string - description: A PNG visualization encoded in a base64 string. title: type: string - description: The visualization title. context: type: string - description: Any filters applied to the visualization. For example, a time filter of April 2024. DvExportStatus: type: object properties: @@ -2246,9 +2344,9 @@ tags: Export Visier data version information, such as tables, columns, and file information, in CSV format.
**Note:** This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM). - - name: Vee + - name: VeeQuery description: |- - Use Vee through Visier APIs, such as asking questions, submitting feedback, and getting sample questions. + Submit questions and context to the Visier Vee engine.
**Note:** This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM). - name: Search