GOgoogle
projects

POST /v1/projects/{projectsId}/locations/{locationsId}/services/nlp:analyzeEntities

Changed on

Analyze heathcare entity in a document. Its response includes the recognized entity mentions and the relationships between them. AnalyzeEntities uses context aware models to detect entities.

Request

  • Base URL
    https://healthcare.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/cloud-healthcare
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/cloud-healthcare
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/cloud-platform
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/cloud-platform
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

projectsIdstring required
locationsIdstring required

Request body

alternativeOutputFormat'ALTERNATIVE_OUTPUT_FORMAT_UNSPECIFIED' | 'FHIR_BUNDLE'

Optional. Alternative output format to be generated based on the results of analysis.

documentContentstring

document_content is a document to be annotated.

licensedVocabulariesstring[]

A list of licensed vocabularies to use in the request, in addition to the default unlicensed vocabularies.

Response

Successful response

fhirBundlestring

The FHIR bundle (R4) that includes all the entities, the entity mentions, and the relationships in JSON format.

Changes

  • 7027c0ced7f9Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-healthcare was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-healthcare was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2c