Skip to content

Commit ca13c6b

Browse files
committed
Update OpenAPI specs
This update comes directly from primary source repo Private OpenAPI repo SHA: d2aad5250b40f366b6f64da807bf4c64f375cbf8 Primary source repo SHA: 92f3edce651c780d1311ec405b86528bdf81904c
1 parent 95e674e commit ca13c6b

File tree

1 file changed

+64
-62
lines changed

1 file changed

+64
-62
lines changed

source_specs/client_rest.yaml

Lines changed: 64 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -4051,6 +4051,68 @@ components:
40514051
description: The document's document_category(.proto).
40524052
sourceDocument:
40534053
$ref: '#/components/schemas/Document'
4054+
FollowupAction:
4055+
description: A follow-up action that can be invoked by the user after a response. The action parameters are not included and need to be predicted/filled separately.
4056+
properties:
4057+
actionRunId:
4058+
type: string
4059+
description: Unique identifier for this actionRun recommendation event.
4060+
actionInstanceId:
4061+
type: string
4062+
description: The ID of the action instance that will be invoked.
4063+
actionId:
4064+
type: string
4065+
description: The ID of the associated action.
4066+
recommendationText:
4067+
type: string
4068+
description: Text to be displayed to the user when recommending the action instance.
4069+
actionLabel:
4070+
type: string
4071+
description: The label to be used when displaying a button to execute this action instance.
4072+
userConfirmationRequired:
4073+
type: boolean
4074+
description: Whether user confirmation is needed before executing this action instance.
4075+
GeneratedQna:
4076+
properties:
4077+
question:
4078+
type: string
4079+
description: Search query rephrased into a question.
4080+
answer:
4081+
type: string
4082+
description: Answer generated for the given query or the generated question.
4083+
followUpPrompts:
4084+
type: array
4085+
items:
4086+
type: string
4087+
description: List of all follow-up prompts generated for the given query or the generated question.
4088+
followupActions:
4089+
description: List of follow-up actions generated for the given query or the generated question.
4090+
type: array
4091+
items:
4092+
$ref: '#/components/schemas/FollowupAction'
4093+
ranges:
4094+
type: array
4095+
items:
4096+
$ref: '#/components/schemas/TextRange'
4097+
description: Answer subsections to mark with special formatting (citations, bolding etc)
4098+
status:
4099+
type: string
4100+
enum:
4101+
- COMPUTING
4102+
- DISABLED
4103+
- FAILED
4104+
- NO_ANSWER
4105+
- SKIPPED
4106+
- STREAMING
4107+
- SUCCEEDED
4108+
- TIMEOUT
4109+
description: Status of backend generating the answer
4110+
cursor:
4111+
type: string
4112+
description: An opaque cursor representing the search request
4113+
trackingToken:
4114+
type: string
4115+
description: An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
40544116
SearchResult:
40554117
required:
40564118
- url
@@ -4402,6 +4464,8 @@ components:
44024464
$ref: '#/components/schemas/CustomEntity'
44034465
answer:
44044466
$ref: '#/components/schemas/Answer'
4467+
generatedQna:
4468+
$ref: '#/components/schemas/GeneratedQna'
44054469
extractedQnA:
44064470
$ref: '#/components/schemas/ExtractedQnA'
44074471
meeting:
@@ -6937,68 +7001,6 @@ components:
69377001
datasourceInstanceDisplayName:
69387002
type: string
69397003
description: The datasource instance display name from which the document was extracted. This is used for appinstance facet filter for datasources that support multiple instances.
6940-
FollowupAction:
6941-
description: A follow-up action that can be invoked by the user after a response. The action parameters are not included and need to be predicted/filled separately.
6942-
properties:
6943-
actionRunId:
6944-
type: string
6945-
description: Unique identifier for this actionRun recommendation event.
6946-
actionInstanceId:
6947-
type: string
6948-
description: The ID of the action instance that will be invoked.
6949-
actionId:
6950-
type: string
6951-
description: The ID of the associated action.
6952-
recommendationText:
6953-
type: string
6954-
description: Text to be displayed to the user when recommending the action instance.
6955-
actionLabel:
6956-
type: string
6957-
description: The label to be used when displaying a button to execute this action instance.
6958-
userConfirmationRequired:
6959-
type: boolean
6960-
description: Whether user confirmation is needed before executing this action instance.
6961-
GeneratedQna:
6962-
properties:
6963-
question:
6964-
type: string
6965-
description: Search query rephrased into a question.
6966-
answer:
6967-
type: string
6968-
description: Answer generated for the given query or the generated question.
6969-
followUpPrompts:
6970-
type: array
6971-
items:
6972-
type: string
6973-
description: List of all follow-up prompts generated for the given query or the generated question.
6974-
followupActions:
6975-
description: List of follow-up actions generated for the given query or the generated question.
6976-
type: array
6977-
items:
6978-
$ref: '#/components/schemas/FollowupAction'
6979-
ranges:
6980-
type: array
6981-
items:
6982-
$ref: '#/components/schemas/TextRange'
6983-
description: Answer subsections to mark with special formatting (citations, bolding etc)
6984-
status:
6985-
type: string
6986-
enum:
6987-
- COMPUTING
6988-
- DISABLED
6989-
- FAILED
6990-
- NO_ANSWER
6991-
- SKIPPED
6992-
- STREAMING
6993-
- SUCCEEDED
6994-
- TIMEOUT
6995-
description: Status of backend generating the answer
6996-
cursor:
6997-
type: string
6998-
description: An opaque cursor representing the search request
6999-
trackingToken:
7000-
type: string
7001-
description: An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
70027004
InvalidOperatorValueError:
70037005
properties:
70047006
key:

0 commit comments

Comments
 (0)