Returns the audioOverviews Resource.
Returns the sources Resource.
batchDelete(parent, body=None, x__xgafv=None)
Batch deletes Notebooks.
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a notebook.
Gets a notebook.
listRecentlyViewed(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists the notebooks ordered by last view time.
Retrieves the next page of results.
share(name, body=None, x__xgafv=None)
Shares a notebook to other accounts.
batchDelete(parent, body=None, x__xgafv=None)
Batch deletes Notebooks.
Args:
parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}`. (required)
body: object, The request body.
The object takes the form of:
{ # Request for NotebookService.BatchDeleteNotebooks method.
"names": [ # Required. Full resource names of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a notebook.
Args:
parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
body: object, The request body.
The object takes the form of:
{ # Notebook is a resource where users can store their content (as sources) and interacts with the content.
"cmekConfig": { # Customer-managed encryption configuration for Notebooks. # Output only. CMEK-related information for the Notebook.
"kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
},
"emoji": "A String", # Output only. The emoji of the notebook.
"metadata": { # Metadata for a notebook. # Output only. The metadata of the notebook.
"createTime": "A String", # The time at which this project was created.
"isShareable": True or False, # True if the project is shareable.
"isShared": True or False, # True if this project is currently shared with other people, false otherwise.
"lastViewed": "A String", # A timestamp indicating the time that the current in session user has last viewed the project.
},
"name": "A String", # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.
"notebookId": "A String", # Output only. Notebook id, which is the last segment of the notebook's resource name.
"sources": [ # Output only. List of sources in the notebook. This is an output only field.
{ # Source represents a single source of content.
"metadata": { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
"agentspaceMetadata": { # Metadata about an agentspace source. # Metadata for an agentspace source.
"documentName": "A String", # Output only. The full document name in Agentspace.
"documentTitle": "A String", # Output only. The title of the document.
},
"googleDocsMetadata": { # Metadata about a google doc source. # Metadata for a google doc source.
"documentId": "A String", # Output only. The document id of the google doc.
"revisionId": "A String", # Output only. Revision id for the doc.
},
"sourceAddedTimestamp": "A String", # The timestamp the source was added.
"tokenCount": 42, # The number of tokens in the source.
"wordCount": 42, # The word count of the source.
"youtubeMetadata": { # Metadata about a youtube video source. # Metadata for a youtube video source.
"channelName": "A String", # Output only. The channel name of the youtube video.
"videoId": "A String", # Output only. The id of the youtube video.
},
},
"name": "A String", # Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
"settings": { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
"failureReason": { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
"audioTranscriptionError": { # An audio file transcription specific error. # An audio file transcription specific error.
"languageDetectionFailed": { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
},
"noAudioDetected": { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
},
},
"domainBlocked": { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
},
"googleDriveError": { # A google drive specific error. # A google drive specific error.
"downloadPrevented": { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
},
},
"ingestionError": { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
},
"paywallError": { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
},
"sourceEmpty": { # Indicates that the source is empty. # Indicates that the source is empty.
},
"sourceLimitExceeded": { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
},
"sourceTooLong": { # Indicates source word count exceeded the user's limit. # Indicates source word count exceeded the user's limit.
"wordCount": 42, # The number of words in the source.
"wordLimit": 42, # The word count limit for the current user at the time of the upload.
},
"sourceUnreachable": { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
"errorDetails": "A String", # Describes why the source is unreachable.
},
"unknown": { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
},
"uploadError": { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
},
"youtubeError": { # A youtube specific error. # A youtube specific error.
"videoDeleted": { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
},
},
},
"status": "A String", # Status of the source.
},
"sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Output only. Source id, which is the last segment of the source's resource name.
"id": "A String", # The id of the source.
},
"title": "A String", # Optional. Title of the source.
},
],
"title": "A String", # Optional. The title of the notebook.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Notebook is a resource where users can store their content (as sources) and interacts with the content.
"cmekConfig": { # Customer-managed encryption configuration for Notebooks. # Output only. CMEK-related information for the Notebook.
"kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
},
"emoji": "A String", # Output only. The emoji of the notebook.
"metadata": { # Metadata for a notebook. # Output only. The metadata of the notebook.
"createTime": "A String", # The time at which this project was created.
"isShareable": True or False, # True if the project is shareable.
"isShared": True or False, # True if this project is currently shared with other people, false otherwise.
"lastViewed": "A String", # A timestamp indicating the time that the current in session user has last viewed the project.
},
"name": "A String", # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.
"notebookId": "A String", # Output only. Notebook id, which is the last segment of the notebook's resource name.
"sources": [ # Output only. List of sources in the notebook. This is an output only field.
{ # Source represents a single source of content.
"metadata": { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
"agentspaceMetadata": { # Metadata about an agentspace source. # Metadata for an agentspace source.
"documentName": "A String", # Output only. The full document name in Agentspace.
"documentTitle": "A String", # Output only. The title of the document.
},
"googleDocsMetadata": { # Metadata about a google doc source. # Metadata for a google doc source.
"documentId": "A String", # Output only. The document id of the google doc.
"revisionId": "A String", # Output only. Revision id for the doc.
},
"sourceAddedTimestamp": "A String", # The timestamp the source was added.
"tokenCount": 42, # The number of tokens in the source.
"wordCount": 42, # The word count of the source.
"youtubeMetadata": { # Metadata about a youtube video source. # Metadata for a youtube video source.
"channelName": "A String", # Output only. The channel name of the youtube video.
"videoId": "A String", # Output only. The id of the youtube video.
},
},
"name": "A String", # Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
"settings": { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
"failureReason": { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
"audioTranscriptionError": { # An audio file transcription specific error. # An audio file transcription specific error.
"languageDetectionFailed": { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
},
"noAudioDetected": { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
},
},
"domainBlocked": { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
},
"googleDriveError": { # A google drive specific error. # A google drive specific error.
"downloadPrevented": { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
},
},
"ingestionError": { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
},
"paywallError": { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
},
"sourceEmpty": { # Indicates that the source is empty. # Indicates that the source is empty.
},
"sourceLimitExceeded": { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
},
"sourceTooLong": { # Indicates source word count exceeded the user's limit. # Indicates source word count exceeded the user's limit.
"wordCount": 42, # The number of words in the source.
"wordLimit": 42, # The word count limit for the current user at the time of the upload.
},
"sourceUnreachable": { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
"errorDetails": "A String", # Describes why the source is unreachable.
},
"unknown": { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
},
"uploadError": { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
},
"youtubeError": { # A youtube specific error. # A youtube specific error.
"videoDeleted": { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
},
},
},
"status": "A String", # Status of the source.
},
"sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Output only. Source id, which is the last segment of the source's resource name.
"id": "A String", # The id of the source.
},
"title": "A String", # Optional. Title of the source.
},
],
"title": "A String", # Optional. The title of the notebook.
}
get(name, x__xgafv=None)
Gets a notebook.
Args:
name: string, Required. Full resource name of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Notebook is a resource where users can store their content (as sources) and interacts with the content.
"cmekConfig": { # Customer-managed encryption configuration for Notebooks. # Output only. CMEK-related information for the Notebook.
"kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
},
"emoji": "A String", # Output only. The emoji of the notebook.
"metadata": { # Metadata for a notebook. # Output only. The metadata of the notebook.
"createTime": "A String", # The time at which this project was created.
"isShareable": True or False, # True if the project is shareable.
"isShared": True or False, # True if this project is currently shared with other people, false otherwise.
"lastViewed": "A String", # A timestamp indicating the time that the current in session user has last viewed the project.
},
"name": "A String", # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.
"notebookId": "A String", # Output only. Notebook id, which is the last segment of the notebook's resource name.
"sources": [ # Output only. List of sources in the notebook. This is an output only field.
{ # Source represents a single source of content.
"metadata": { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
"agentspaceMetadata": { # Metadata about an agentspace source. # Metadata for an agentspace source.
"documentName": "A String", # Output only. The full document name in Agentspace.
"documentTitle": "A String", # Output only. The title of the document.
},
"googleDocsMetadata": { # Metadata about a google doc source. # Metadata for a google doc source.
"documentId": "A String", # Output only. The document id of the google doc.
"revisionId": "A String", # Output only. Revision id for the doc.
},
"sourceAddedTimestamp": "A String", # The timestamp the source was added.
"tokenCount": 42, # The number of tokens in the source.
"wordCount": 42, # The word count of the source.
"youtubeMetadata": { # Metadata about a youtube video source. # Metadata for a youtube video source.
"channelName": "A String", # Output only. The channel name of the youtube video.
"videoId": "A String", # Output only. The id of the youtube video.
},
},
"name": "A String", # Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
"settings": { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
"failureReason": { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
"audioTranscriptionError": { # An audio file transcription specific error. # An audio file transcription specific error.
"languageDetectionFailed": { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
},
"noAudioDetected": { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
},
},
"domainBlocked": { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
},
"googleDriveError": { # A google drive specific error. # A google drive specific error.
"downloadPrevented": { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
},
},
"ingestionError": { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
},
"paywallError": { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
},
"sourceEmpty": { # Indicates that the source is empty. # Indicates that the source is empty.
},
"sourceLimitExceeded": { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
},
"sourceTooLong": { # Indicates source word count exceeded the user's limit. # Indicates source word count exceeded the user's limit.
"wordCount": 42, # The number of words in the source.
"wordLimit": 42, # The word count limit for the current user at the time of the upload.
},
"sourceUnreachable": { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
"errorDetails": "A String", # Describes why the source is unreachable.
},
"unknown": { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
},
"uploadError": { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
},
"youtubeError": { # A youtube specific error. # A youtube specific error.
"videoDeleted": { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
},
},
},
"status": "A String", # Status of the source.
},
"sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Output only. Source id, which is the last segment of the source's resource name.
"id": "A String", # The id of the source.
},
"title": "A String", # Optional. Title of the source.
},
],
"title": "A String", # Optional. The title of the notebook.
}
listRecentlyViewed(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists the notebooks ordered by last view time.
Args:
parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}`. (required)
pageSize: integer, Optional. Maximum number of Notebooks to return. If unspecified, defaults to "500". The maximum allowed value is "500". If this field is negative, will use the default value.
pageToken: string, Optional. The page token, provide this to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for NotebookService.ListRecentlyViewedNotebooks method.
"nextPageToken": "A String", # The page token, provide this to retrieve the subsequent page.
"notebooks": [ # The list of recently viewed notebooks.
{ # Notebook is a resource where users can store their content (as sources) and interacts with the content.
"cmekConfig": { # Customer-managed encryption configuration for Notebooks. # Output only. CMEK-related information for the Notebook.
"kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
},
"emoji": "A String", # Output only. The emoji of the notebook.
"metadata": { # Metadata for a notebook. # Output only. The metadata of the notebook.
"createTime": "A String", # The time at which this project was created.
"isShareable": True or False, # True if the project is shareable.
"isShared": True or False, # True if this project is currently shared with other people, false otherwise.
"lastViewed": "A String", # A timestamp indicating the time that the current in session user has last viewed the project.
},
"name": "A String", # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.
"notebookId": "A String", # Output only. Notebook id, which is the last segment of the notebook's resource name.
"sources": [ # Output only. List of sources in the notebook. This is an output only field.
{ # Source represents a single source of content.
"metadata": { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
"agentspaceMetadata": { # Metadata about an agentspace source. # Metadata for an agentspace source.
"documentName": "A String", # Output only. The full document name in Agentspace.
"documentTitle": "A String", # Output only. The title of the document.
},
"googleDocsMetadata": { # Metadata about a google doc source. # Metadata for a google doc source.
"documentId": "A String", # Output only. The document id of the google doc.
"revisionId": "A String", # Output only. Revision id for the doc.
},
"sourceAddedTimestamp": "A String", # The timestamp the source was added.
"tokenCount": 42, # The number of tokens in the source.
"wordCount": 42, # The word count of the source.
"youtubeMetadata": { # Metadata about a youtube video source. # Metadata for a youtube video source.
"channelName": "A String", # Output only. The channel name of the youtube video.
"videoId": "A String", # Output only. The id of the youtube video.
},
},
"name": "A String", # Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
"settings": { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
"failureReason": { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
"audioTranscriptionError": { # An audio file transcription specific error. # An audio file transcription specific error.
"languageDetectionFailed": { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
},
"noAudioDetected": { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
},
},
"domainBlocked": { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
},
"googleDriveError": { # A google drive specific error. # A google drive specific error.
"downloadPrevented": { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
},
},
"ingestionError": { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
},
"paywallError": { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
},
"sourceEmpty": { # Indicates that the source is empty. # Indicates that the source is empty.
},
"sourceLimitExceeded": { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
},
"sourceTooLong": { # Indicates source word count exceeded the user's limit. # Indicates source word count exceeded the user's limit.
"wordCount": 42, # The number of words in the source.
"wordLimit": 42, # The word count limit for the current user at the time of the upload.
},
"sourceUnreachable": { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
"errorDetails": "A String", # Describes why the source is unreachable.
},
"unknown": { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
},
"uploadError": { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
},
"youtubeError": { # A youtube specific error. # A youtube specific error.
"videoDeleted": { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
},
},
},
"status": "A String", # Status of the source.
},
"sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Output only. Source id, which is the last segment of the source's resource name.
"id": "A String", # The id of the source.
},
"title": "A String", # Optional. Title of the source.
},
],
"title": "A String", # Optional. The title of the notebook.
},
],
}
listRecentlyViewed_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
share(name, body=None, x__xgafv=None)
Shares a notebook to other accounts.
Args:
name: string, Required. Full resource name of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`. (required)
body: object, The request body.
The object takes the form of:
{ # Request for NotebookService.ShareNotebook method.
"accountAndRoles": [ # Required. The list of accounts and roles to share the notebook with.
{ # Account and role information.
"email": "A String", # Required. The email address associated with the account.
"role": "A String", # Required. The role in the notebook.
},
],
"notifyViaEmail": True or False, # Required. Whether to notify the shared users via email.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for NotebookService.ShareNotebook method.
}