diff --git a/core-services/document-grounding/src/main/resources/spec/grounding.yaml b/core-services/document-grounding/src/main/resources/spec/grounding.yaml index 50ae76a4f..74a2f0cc4 100644 --- a/core-services/document-grounding/src/main/resources/spec/grounding.yaml +++ b/core-services/document-grounding/src/main/resources/spec/grounding.yaml @@ -22,19 +22,19 @@ servers: variables: region: enum: - - prod.eu-central-1.aws - - prodeuonly.eu-central-1.aws - - prod.us-east-1.aws - - prod.ap-northeast-1.aws - - prod.ap-southeast-2.aws - - prod-eu20.westeurope.azure - - prod-eu30.europe-west3.gcp - - prod-us21.eastus.azure - - prod-us30.us-central1.gcp - - prod-ap20.australiaeast.az - - prod-ap11.ap-southeast-1.aws + - prod.eu-central-1.aws + - prodeuonly.eu-central-1.aws + - prod.us-east-1.aws + - prod.ap-northeast-1.aws + - prod.ap-southeast-2.aws + - prod-eu20.westeurope.azure + - prod-eu30.europe-west3.gcp + - prod-us21.eastus.azure + - prod-us30.us-central1.gcp + - prod-ap20.australiaeast.az + - prod-ap11.ap-southeast-1.aws default: prod.eu-central-1.aws - service: + service: default: document-grounding paths: "/pipelines": @@ -403,7 +403,7 @@ paths: "/pipelines/trigger": post: tags: - - Pipelines + - Pipelines operationId: pipeline.v1.pipeline_endpoints.trigger_pipeline summary: Pipeline Trigger description: Manually trigger a pipeline @@ -432,7 +432,7 @@ paths: format: uri '400': $ref: '#/components/responses/BadRequest' - + "/vector/collections": get: parameters: @@ -984,7 +984,7 @@ components: flows: clientCredentials: tokenUrl: https://(subdomain_identity_zone).authentication.(host)/oauth/token - scopes: { } + scopes: {} schemas: createPipeline: oneOf: @@ -1007,7 +1007,7 @@ components: properties: pipelineId: type: string - example: uuid + example: uuid MSSharePointPipelineCreateRequest: type: object @@ -1017,7 +1017,7 @@ components: properties: type: type: string - enum: [ MSSharePoint ] + enum: [MSSharePoint] configuration: $ref: "#/components/schemas/MSSharePointConfiguration" metadata: @@ -1032,7 +1032,7 @@ components: properties: type: type: string - enum: [ S3 ] + enum: [S3] configuration: $ref: "#/components/schemas/S3Configuration" metadata: @@ -1047,7 +1047,7 @@ components: properties: type: type: string - enum: [ SFTP ] + enum: [SFTP] configuration: $ref: "#/components/schemas/SFTPConfiguration" metadata: @@ -1062,11 +1062,11 @@ components: properties: type: type: string - enum: [ SDM ] + enum: [SDM] metadata: $ref: "#/components/schemas/MetaData" additionalProperties: true - + WorkZonePipelineCreateRequest: type: object required: @@ -1075,7 +1075,7 @@ components: properties: type: type: string - enum: [ WorkZone ] + enum: [WorkZone] metadata: $ref: "#/components/schemas/MetaData" additionalProperties: true @@ -1138,7 +1138,7 @@ components: - /testFolder1 - /testFolder2 additionalProperties: true - + S3Configuration: type: object required: @@ -1206,7 +1206,7 @@ components: properties: type: type: string - enum: [ MSSharePoint ] + enum: [MSSharePoint] configuration: $ref: "#/components/schemas/MSSharePointConfigurationGetResponse" @@ -1219,7 +1219,7 @@ components: properties: type: type: string - enum: [ S3 ] + enum: [S3] configuration: $ref: "#/components/schemas/S3Configuration" @@ -1232,7 +1232,7 @@ components: properties: type: type: string - enum: [ SFTP ] + enum: [SFTP] configuration: $ref: "#/components/schemas/SFTPConfiguration" @@ -1245,10 +1245,10 @@ components: properties: type: type: string - enum: [ SDM ] + enum: [SDM] metadata: $ref: "#/components/schemas/MetaData" - + WorkZonePipelineGetResponse: allOf: - $ref: "#/components/schemas/BasePipelineResponse" @@ -1258,9 +1258,9 @@ components: properties: type: type: string - enum: [ WorkZone ] + enum: [WorkZone] metadata: - $ref: "#/components/schemas/MetaData" + $ref: "#/components/schemas/MetaData" BasePipelineResponse: type: object @@ -1326,7 +1326,7 @@ components: example: '2024-02-15T12:45:00.000Z' nullable: true status: - $ref: '#/components/schemas/PipelineExecutionStatus' + $ref: '#/components/schemas/PipelineExecutionStatus' pipelineId: type: object @@ -1364,7 +1364,7 @@ components: pattern: '^$|^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d{3})?Z$' example: '2024-02-15T12:45:00Z' nullable: true - + getPipelineExecutions: type: object properties: @@ -1488,11 +1488,11 @@ components: items: $ref: "#/components/schemas/KeyValueListPair" title: Metadata - default: [ ] + default: [] type: object required: - - id - - content + - id + - content title: Chunk VectorChunk: properties: @@ -1507,11 +1507,11 @@ components: items: $ref: "#/components/schemas/VectorKeyValueListPair" title: Metadata - default: [ ] + default: [] type: object required: - - id - - content + - id + - content title: VectorChunk RetrievalChunk: properties: @@ -1526,11 +1526,11 @@ components: items: $ref: "#/components/schemas/RetrievalKeyValueListPair" title: Metadata - default: [ ] + default: [] type: object required: - - id - - content + - id + - content title: RetrievalChunk DocumentKeyValueListPair: properties: @@ -1552,13 +1552,13 @@ components: default: ANY anyOf: - enum: - - ANY - - ALL - - { } + - ANY + - ALL + - {} type: object required: - - key - - value + - key + - value title: DocumentKeyValueListPair VectorDocumentKeyValueListPair: properties: @@ -1580,13 +1580,13 @@ components: default: ANY anyOf: - enum: - - ANY - - ALL - - { } + - ANY + - ALL + - {} type: object required: - - key - - value + - key + - value title: VectorDocumentKeyValueListPair RetrievalDocumentKeyValueListPair: properties: @@ -1608,15 +1608,15 @@ components: default: ANY anyOf: - enum: - - ANY - - ALL - - { } + - ANY + - ALL + - {} type: object required: - - key - - value + - key + - value title: DocumentKeyValueListPair - + HTTPValidationError: properties: detail: @@ -1640,8 +1640,8 @@ components: title: Value type: object required: - - key - - value + - key + - value title: KeyValueListPair VectorKeyValueListPair: properties: @@ -1657,8 +1657,8 @@ components: title: Value type: object required: - - key - - value + - key + - value title: VectorKeyValueListPair RetrievalKeyValueListPair: properties: @@ -1674,8 +1674,8 @@ components: title: Value type: object required: - - key - - value + - key + - value title: RetrievalKeyValueListPair Document-Output: properties: @@ -1688,7 +1688,7 @@ components: $ref: '#/components/schemas/VectorDocumentKeyValueListPair' type: array title: Metadata - default: [ ] + default: [] chunks: items: $ref: '#/components/schemas/VectorChunk' @@ -1713,7 +1713,7 @@ components: $ref: '#/components/schemas/VectorKeyValueListPair' type: array title: Metadata - default: [ ] + default: [] documents: items: $ref: '#/components/schemas/Document-Output' @@ -1831,8 +1831,8 @@ components: description: Select mode for search filters type: object required: - - key - - value + - key + - value title: SearchDocumentKeyValueListPair VectorSearchDocumentKeyValueListPair: properties: @@ -1854,8 +1854,8 @@ components: description: Select mode for search filters type: object required: - - key - - value + - key + - value title: VectorSearchDocumentKeyValueListPair RetrievalSearchDocumentKeyValueListPair: properties: @@ -1877,8 +1877,8 @@ components: description: Select mode for search filters type: object required: - - key - - value + - key + - value title: RetrievalSearchDocumentKeyValueListPair SearchResults: properties: @@ -1886,12 +1886,12 @@ components: type: array items: anyOf: - - $ref: "#/components/schemas/PerFilterSearchResult" + - $ref: "#/components/schemas/PerFilterSearchResult" title: Results description: List of returned results. type: object required: - - results + - results title: SearchResults VectorSearchResults: properties: @@ -1899,12 +1899,12 @@ components: type: array items: anyOf: - - $ref: "#/components/schemas/VectorPerFilterSearchResult" + - $ref: "#/components/schemas/VectorPerFilterSearchResult" title: Results description: List of returned results. type: object required: - - results + - results title: VectorSearchResults CollectionsListResponse: @@ -1937,7 +1937,7 @@ components: description: >- Metadata attached to collection. Useful to restrict search to a subset of collections. - default: [ ] + default: [] type: object required: - embeddingConfig @@ -2143,24 +2143,24 @@ components: type: string anyOf: - enum: - - ignoreIfKeyAbsent - - { } + - ignoreIfKeyAbsent + - {} default: ignoreIfKeyAbsent title: SearchSelectOptionEnum VectorSearchSelectOptionEnum: type: string anyOf: - enum: - - ignoreIfKeyAbsent - - { } + - ignoreIfKeyAbsent + - {} default: ignoreIfKeyAbsent title: VectorSearchSelectOptionEnum RetrievalSearchSelectOptionEnum: type: string anyOf: - enum: - - ignoreIfKeyAbsent - - { } + - ignoreIfKeyAbsent + - {} title: RetrievalSearchSelectOptionEnum SearchFilter: properties: @@ -2184,7 +2184,7 @@ components: description: >- Restrict collections considered during search to those annotated with the given metadata. Useful when combined with collections=['*'] - default: [ ] + default: [] documentMetadata: items: $ref: '#/components/schemas/SearchDocumentKeyValueListPair' @@ -2194,7 +2194,7 @@ components: description: >- Restrict documents considered during search to those annotated with the given metadata. - default: [ ] + default: [] chunkMetadata: items: $ref: '#/components/schemas/KeyValueListPair' @@ -2204,7 +2204,7 @@ components: description: >- Restrict chunks considered during search to those with the given metadata. - default: [ ] + default: [] type: object required: - id @@ -2233,7 +2233,7 @@ components: description: >- Restrict collections considered during search to those annotated with the given metadata. Useful when combined with collections=['*'] - default: [ ] + default: [] documentMetadata: items: $ref: '#/components/schemas/VectorSearchDocumentKeyValueListPair' @@ -2243,7 +2243,7 @@ components: description: >- Restrict documents considered during search to those annotated with the given metadata. - default: [ ] + default: [] chunkMetadata: items: $ref: '#/components/schemas/VectorKeyValueListPair' @@ -2253,7 +2253,7 @@ components: description: >- Restrict chunks considered during search to those with the given metadata. - default: [ ] + default: [] type: object required: - id @@ -2303,7 +2303,7 @@ components: description: >- Metadata attached to collection. Useful to restrict search to a subset of collections. - default: [ ] + default: [] id: type: string format: uuid @@ -2326,7 +2326,7 @@ components: title: Datarepositories type: object required: - - resources + - resources title: DataRepositories DataRepository: properties: @@ -2344,14 +2344,14 @@ components: $ref: "#/components/schemas/RetrievalKeyValueListPair" title: Metadata description: Metadata attached to DataRepository. Useful to later limit search to a subset of DataRepositories. - default: [ ] + default: [] type: $ref: "#/components/schemas/DataRepositoryType" type: object required: - - id - - title - - type + - id + - title + - type title: DataRepository description: DataRepository schema expected by Retrieval. DataRepositorySearchResult: @@ -2360,15 +2360,15 @@ components: $ref: "#/components/schemas/DataRepositoryWithDocuments" type: object required: - - dataRepository + - dataRepository title: DataRepositorySearchResult DataRepositoryType: type: string anyOf: - enum: - - vector - - help.sap.com - - { } + - vector + - help.sap.com + - {} title: DataRepositoryType DataRepositoryWithDocuments: properties: @@ -2393,9 +2393,9 @@ components: title: Documents type: object required: - - id - - title - - documents + - id + - title + - documents title: DataRepositoryWithDocuments description: DataRepository schema returned by the Vector search endpoint Document: @@ -2408,7 +2408,7 @@ components: items: $ref: "#/components/schemas/RetrievalDocumentKeyValueListPair" title: Metadata - default: [ ] + default: [] chunks: type: array items: @@ -2416,8 +2416,8 @@ components: title: RetrievalChunks type: object required: - - id - - chunks + - id + - chunks title: Document DataRepositoryPerFilterSearchResult: properties: @@ -2430,10 +2430,10 @@ components: $ref: "#/components/schemas/DataRepositorySearchResult" title: Results description: List of returned results. - default: [ ] + default: [] type: object required: - - filterId + - filterId title: PerFilterSearchResult PerFilterSearchResultError: properties: @@ -2442,7 +2442,7 @@ components: title: Message type: object required: - - message + - message title: PerFilterSearchResultError RetrievalPerFilterSearchResultError: properties: @@ -2451,7 +2451,7 @@ components: title: Message type: object required: - - message + - message title: RetrievalPerFilterSearchResultError PerFilterSearchResultWithError: properties: @@ -2465,7 +2465,7 @@ components: message: Unknown Error Occurred type: object required: - - filterId + - filterId title: PerFilterSearchResultWithError RetrievalSearchFilter: properties: @@ -2477,7 +2477,7 @@ components: type: object nullable: true $ref: "#/components/schemas/RetrievalSearchConfiguration" - default: { } + default: {} minProperties: 0 maxProperties: 2 dataRepositories: @@ -2487,7 +2487,7 @@ components: title: Datarepositories description: Specify ['*'] to search across all DataRepositories or give a specific list of DataRepository ids. default: - - "*" + - "*" dataRepositoryType: type: string $ref: "#/components/schemas/DataRepositoryType" @@ -2498,25 +2498,25 @@ components: $ref: "#/components/schemas/RetrievalKeyValueListPair" title: Datarepositorymetadata description: Restrict DataRepositories considered during search to those annotated with the given metadata. Useful when combined with dataRepositories=['*'] - default: [ ] + default: [] documentMetadata: type: array items: $ref: "#/components/schemas/RetrievalSearchDocumentKeyValueListPair" title: Documentmetadata description: Restrict documents considered during search to those annotated with the given metadata. - default: [ ] + default: [] chunkMetadata: type: array items: $ref: "#/components/schemas/RetrievalKeyValueListPair" title: Chunkmetadata description: Restrict chunks considered during search to those with the given metadata. - default: [ ] + default: [] type: object required: - - id - - dataRepositoryType + - id + - dataRepositoryType title: RetrievalSearchFilter description: Limit scope of search to certain DataRepositories, Documents or Chunks. RetrievalSearchInput: @@ -2533,8 +2533,8 @@ components: title: Filters type: object required: - - query - - filters + - query + - filters title: RetrievalSearchInput RetrievalDataRepositorySearchResult: properties: @@ -2542,7 +2542,7 @@ components: $ref: "#/components/schemas/DataRepositoryWithDocuments" type: object required: - - dataRepository + - dataRepository title: RetrievalDataRepositorySearchResult RetrievalPerFilterSearchResult: properties: @@ -2555,10 +2555,10 @@ components: $ref: "#/components/schemas/RetrievalDataRepositorySearchResult" title: Results description: List of returned results. - default: [ ] + default: [] type: object required: - - filterId + - filterId title: RetrievalPerFilterSearchResult RetrievalPerFilterSearchResultWithError: properties: @@ -2572,7 +2572,7 @@ components: message: Unknown Error Occurred type: object required: - - filterId + - filterId title: RetrievalPerFilterSearchResultWithError RetrievalSearchResults: properties: @@ -2580,13 +2580,13 @@ components: type: array items: anyOf: - - $ref: "#/components/schemas/RetrievalPerFilterSearchResult" - - $ref: "#/components/schemas/RetrievalPerFilterSearchResultWithError" + - $ref: "#/components/schemas/RetrievalPerFilterSearchResult" + - $ref: "#/components/schemas/RetrievalPerFilterSearchResultWithError" title: Results description: List of returned results. type: object required: - - results + - results title: RetrievalSearchResults DataRepositorySearchResults: properties: @@ -2594,13 +2594,13 @@ components: type: array items: anyOf: - - $ref: "#/components/schemas/DataRepositoryPerFilterSearchResult" - - $ref: "#/components/schemas/PerFilterSearchResultWithError" + - $ref: "#/components/schemas/DataRepositoryPerFilterSearchResult" + - $ref: "#/components/schemas/PerFilterSearchResultWithError" title: Results description: List of returned results. type: object required: - - results + - results title: SearchResults ValidationError: properties: @@ -2617,9 +2617,9 @@ components: title: Error Type type: object required: - - loc - - msg - - type + - loc + - msg + - type title: ValidationError ### ### ######################## ### ###