Discovery Engine API (discoveryengine:v1alpha)

2024-03-20

2 new methods

Additions

    Methods
  • discoveryengine.projects.locations.collections.dataStores.branches.documents.getProcessedDocument

      Path: v1alpha/{+name}:getProcessedDocument

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}:getProcessedDocument

      HTTP Method: GET

      Parameters:

        name

          Description: Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.

          Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$

          Location: path

          Required: Yes

          Type: string

        processedDocumentType

          Description: Required. What type of processing to return.

          Location: query

          Type: string

          Enum Descriptions:

        • Default value.
        • Available for all data store parsing configs.
        • Only available if ChunkingConfig is enabeld on the data store.
        • Enum:

        • PROCESSED_DOCUMENT_TYPE_UNSPECIFIED
        • PARSED_DOCUMENT
        • CHUNKED_DOCUMENT

        processedDocumentFormat

          Description: What format output should be. If unspecified, defaults to JSON.

          Location: query

          Type: string

          Enum Descriptions:

        • Default value.
        • output format will be a JSON string representation of processed document.
        • Enum:

        • PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED
        • JSON

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets the parsed layout information for a Document.

  • discoveryengine.projects.locations.dataStores.branches.documents.getProcessedDocument

      Path: v1alpha/{+name}:getProcessedDocument

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}:getProcessedDocument

      HTTP Method: GET

      Parameters:

        name

          Description: Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.

          Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$

          Location: path

          Required: Yes

          Type: string

        processedDocumentType

          Description: Required. What type of processing to return.

          Location: query

          Type: string

          Enum Descriptions:

        • Default value.
        • Available for all data store parsing configs.
        • Only available if ChunkingConfig is enabeld on the data store.
        • Enum:

        • PROCESSED_DOCUMENT_TYPE_UNSPECIFIED
        • PARSED_DOCUMENT
        • CHUNKED_DOCUMENT

        processedDocumentFormat

          Description: What format output should be. If unspecified, defaults to JSON.

          Location: query

          Type: string

          Enum Descriptions:

        • Default value.
        • output format will be a JSON string representation of processed document.
        • Enum:

        • PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED
        • JSON

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets the parsed layout information for a Document.