`nemo_microservices.resources.intake.entries.entries`#

Module Contents#

Classes#

`AsyncEntriesResource`
`AsyncEntriesResourceWithRawResponse`
`AsyncEntriesResourceWithStreamingResponse`
`EntriesResource`
`EntriesResourceWithRawResponse`
`EntriesResourceWithStreamingResponse`

API#

class nemo_microservices.resources.intake.entries.entries.AsyncEntriesResource( client: nemo_microservices._client.AsyncNeMoMicroservices, )#

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

async create( *, context: nemo_microservices.types.intake.entry_context_param.EntryContextParam, data: nemo_microservices.types.intake.entry_data_param.EntryDataParam, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, events: Iterable[nemo_microservices.types.intake.entry_create_params.Event] | nemo_microservices._types.Omit = omit, external_id: str | nemo_microservices._types.Omit = omit, namespace: str | nemo_microservices._types.Omit = omit, ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit, project: str | nemo_microservices._types.Omit = omit, user_rating: nemo_microservices.types.intake.user_rating_param.UserRatingParam | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.intake.entry.Entry#

Create a new entry.

Apps and tasks referenced in the entry context will be auto-created if they don’t exist.

Args: context: Contextual metadata attached to every entry record.

  Keeping these grouped in a dedicated object avoids polluting the top-level
  namespace and makes it trivial to extend without breaking compatibility.

data: Entry data containing the request and response for an LLM interaction.

custom_fields: A set of custom fields that the user can define and use for various purposes.

description: The description of the entity.

events: All events associated with this entry.

external_id: Optional client-provided identifier (e.g., completion_id from an LLM provider like OpenAI or NIM). Must be globally unique if provided—attempting to create an entry with a duplicate external_id will fail with a 409 error. If your service provides unique IDs (like ‘chatcmpl-abc123’), you should use them here for easier lookups. Entries can be retrieved using external_id via the prefix syntax: GET /entries/external:chatcmpl-abc123

namespace: The namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.

ownership: Information about ownership of an entity.

  If the entity is a namespace, the `access_policies` will typically apply to all
  entities inside the namespace.

project: The URN of the project associated with this entity.

user_rating: User’s rating/evaluation of an AI response.

  This captures various forms of end-user feedback about a model's response,
  including binary thumbs up/down ratings, numeric scores, free-text opinions,
  suggested rewrites, and structured category ratings.

  Either `thumb` or `rating` should be provided (they are mutually exclusive), but
  all fields are optional to accommodate different feedback collection patterns.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async delete( entry_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → None#

Delete an entry by ID or external_id.

Use external:{external_id} to delete by external_id. Example: /v1/intake/entries/external:chatcmpl-abc123

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property events: nemo_microservices.resources.intake.entries.events.AsyncEventsResource#

list( *, filter: nemo_microservices.types.intake.entry_filter_param.EntryFilterParam | nemo_microservices._types.Omit = omit, page: int | nemo_microservices._types.Omit = omit, page_size: int | nemo_microservices._types.Omit = omit, search: nemo_microservices.types.intake.entry_search_param.EntrySearchParam | nemo_microservices._types.Omit = omit, sort: nemo_microservices.types.intake.entry_sort_field.EntrySortField | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices._base_client.AsyncPaginator[nemo_microservices.types.intake.entry.Entry, nemo_microservices.pagination.AsyncDefaultPagination[nemo_microservices.types.intake.entry.Entry]]#

List all entries with filtering and search capabilities.

When longest_per_thread=true is set in filters, returns only the longest entry (by message count) for each unique thread_id.

Args: filter: Filter entries on various criteria.

  Examples:

  - `?filter[namespace]=default`: Filter by namespace
  - `?filter[app]=default/my-app`: Filter by app reference
  - `?filter[has_thumb]=true`: Filter entries with thumb feedback
  - `?filter[longest_per_thread]=true`: Return only longest entry per thread

page: Page number.

page_size: Page size.

search: Search entries using substring matching.

sort: Sort fields for Entries.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async retrieve( entry_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.intake.entry.Entry#

Get a specific entry by ID or external_id.

Use external:{external_id} to get by external_id. Example: /v1/intake/entries/external:chatcmpl-abc123

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async update( entry_id: str, *, context: nemo_microservices.types.intake.entry_context_param.EntryContextParam | nemo_microservices._types.Omit = omit, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, data: nemo_microservices.types.intake.entry_data_param.EntryDataParam | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, events: Iterable[nemo_microservices.types.intake.entry_update_params.Event] | nemo_microservices._types.Omit = omit, ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit, project: str | nemo_microservices._types.Omit = omit, user_rating: nemo_microservices.types.intake.user_rating_param.UserRatingParam | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.intake.entry.Entry#

Update an existing entry by ID or external_id.

Use external:{external_id} to update by external_id. Example: /v1/intake/entries/external:chatcmpl-abc123

Args: context: Contextual metadata attached to every entry record.

  Keeping these grouped in a dedicated object avoids polluting the top-level
  namespace and makes it trivial to extend without breaking compatibility.

custom_fields: A set of custom fields that the user can define and use for various purposes.

data: Entry data containing the request and response for an LLM interaction.

description: The description of the entity.

events: All events associated with this entry.

ownership: Information about ownership of an entity.

  If the entity is a namespace, the `access_policies` will typically apply to all
  entities inside the namespace.

project: The URN of the project associated with this entity.

user_rating: User’s rating/evaluation of an AI response.

  This captures various forms of end-user feedback about a model's response,
  including binary thumbs up/down ratings, numeric scores, free-text opinions,
  suggested rewrites, and structured category ratings.

  Either `thumb` or `rating` should be provided (they are mutually exclusive), but
  all fields are optional to accommodate different feedback collection patterns.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property with_raw_response: nemo_microservices.resources.intake.entries.entries.AsyncEntriesResourceWithRawResponse#

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#accessing-raw-response-data-e-g-headers

property with_streaming_response: nemo_microservices.resources.intake.entries.entries.AsyncEntriesResourceWithStreamingResponse#

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#with_streaming_response

class nemo_microservices.resources.intake.entries.entries.AsyncEntriesResourceWithRawResponse( entries: nemo_microservices.resources.intake.entries.entries.AsyncEntriesResource, )#

Initialization

property events: nemo_microservices.resources.intake.entries.events.AsyncEventsResourceWithRawResponse#

class nemo_microservices.resources.intake.entries.entries.AsyncEntriesResourceWithStreamingResponse( entries: nemo_microservices.resources.intake.entries.entries.AsyncEntriesResource, )#

Initialization

property events: nemo_microservices.resources.intake.entries.events.AsyncEventsResourceWithStreamingResponse#

class nemo_microservices.resources.intake.entries.entries.EntriesResource(client: nemo_microservices._client.NeMoMicroservices)#

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

create( *, context: nemo_microservices.types.intake.entry_context_param.EntryContextParam, data: nemo_microservices.types.intake.entry_data_param.EntryDataParam, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, events: Iterable[nemo_microservices.types.intake.entry_create_params.Event] | nemo_microservices._types.Omit = omit, external_id: str | nemo_microservices._types.Omit = omit, namespace: str | nemo_microservices._types.Omit = omit, ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit, project: str | nemo_microservices._types.Omit = omit, user_rating: nemo_microservices.types.intake.user_rating_param.UserRatingParam | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.intake.entry.Entry#

Create a new entry.

Apps and tasks referenced in the entry context will be auto-created if they don’t exist.

Args: context: Contextual metadata attached to every entry record.

  Keeping these grouped in a dedicated object avoids polluting the top-level
  namespace and makes it trivial to extend without breaking compatibility.

data: Entry data containing the request and response for an LLM interaction.

custom_fields: A set of custom fields that the user can define and use for various purposes.

description: The description of the entity.

events: All events associated with this entry.

external_id: Optional client-provided identifier (e.g., completion_id from an LLM provider like OpenAI or NIM). Must be globally unique if provided—attempting to create an entry with a duplicate external_id will fail with a 409 error. If your service provides unique IDs (like ‘chatcmpl-abc123’), you should use them here for easier lookups. Entries can be retrieved using external_id via the prefix syntax: GET /entries/external:chatcmpl-abc123

namespace: The namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.

ownership: Information about ownership of an entity.

  If the entity is a namespace, the `access_policies` will typically apply to all
  entities inside the namespace.

project: The URN of the project associated with this entity.

user_rating: User’s rating/evaluation of an AI response.

  This captures various forms of end-user feedback about a model's response,
  including binary thumbs up/down ratings, numeric scores, free-text opinions,
  suggested rewrites, and structured category ratings.

  Either `thumb` or `rating` should be provided (they are mutually exclusive), but
  all fields are optional to accommodate different feedback collection patterns.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

delete( entry_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → None#

Delete an entry by ID or external_id.

Use external:{external_id} to delete by external_id. Example: /v1/intake/entries/external:chatcmpl-abc123

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property events: nemo_microservices.resources.intake.entries.events.EventsResource#

list( *, filter: nemo_microservices.types.intake.entry_filter_param.EntryFilterParam | nemo_microservices._types.Omit = omit, page: int | nemo_microservices._types.Omit = omit, page_size: int | nemo_microservices._types.Omit = omit, search: nemo_microservices.types.intake.entry_search_param.EntrySearchParam | nemo_microservices._types.Omit = omit, sort: nemo_microservices.types.intake.entry_sort_field.EntrySortField | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.pagination.SyncDefaultPagination[nemo_microservices.types.intake.entry.Entry]#

List all entries with filtering and search capabilities.

When longest_per_thread=true is set in filters, returns only the longest entry (by message count) for each unique thread_id.

Args: filter: Filter entries on various criteria.

  Examples:

  - `?filter[namespace]=default`: Filter by namespace
  - `?filter[app]=default/my-app`: Filter by app reference
  - `?filter[has_thumb]=true`: Filter entries with thumb feedback
  - `?filter[longest_per_thread]=true`: Return only longest entry per thread

page: Page number.

page_size: Page size.

search: Search entries using substring matching.

sort: Sort fields for Entries.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

retrieve( entry_id: str, *, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.intake.entry.Entry#

Get a specific entry by ID or external_id.

Use external:{external_id} to get by external_id. Example: /v1/intake/entries/external:chatcmpl-abc123

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

update( entry_id: str, *, context: nemo_microservices.types.intake.entry_context_param.EntryContextParam | nemo_microservices._types.Omit = omit, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, data: nemo_microservices.types.intake.entry_data_param.EntryDataParam | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, events: Iterable[nemo_microservices.types.intake.entry_update_params.Event] | nemo_microservices._types.Omit = omit, ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit, project: str | nemo_microservices._types.Omit = omit, user_rating: nemo_microservices.types.intake.user_rating_param.UserRatingParam | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.intake.entry.Entry#

Update an existing entry by ID or external_id.

Use external:{external_id} to update by external_id. Example: /v1/intake/entries/external:chatcmpl-abc123

Args: context: Contextual metadata attached to every entry record.

  Keeping these grouped in a dedicated object avoids polluting the top-level
  namespace and makes it trivial to extend without breaking compatibility.

custom_fields: A set of custom fields that the user can define and use for various purposes.

data: Entry data containing the request and response for an LLM interaction.

description: The description of the entity.

events: All events associated with this entry.

ownership: Information about ownership of an entity.

  If the entity is a namespace, the `access_policies` will typically apply to all
  entities inside the namespace.

project: The URN of the project associated with this entity.

user_rating: User’s rating/evaluation of an AI response.

  This captures various forms of end-user feedback about a model's response,
  including binary thumbs up/down ratings, numeric scores, free-text opinions,
  suggested rewrites, and structured category ratings.

  Either `thumb` or `rating` should be provided (they are mutually exclusive), but
  all fields are optional to accommodate different feedback collection patterns.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property with_raw_response: nemo_microservices.resources.intake.entries.entries.EntriesResourceWithRawResponse#

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#accessing-raw-response-data-e-g-headers

property with_streaming_response: nemo_microservices.resources.intake.entries.entries.EntriesResourceWithStreamingResponse#

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#with_streaming_response

class nemo_microservices.resources.intake.entries.entries.EntriesResourceWithRawResponse( entries: nemo_microservices.resources.intake.entries.entries.EntriesResource, )#

Initialization

property events: nemo_microservices.resources.intake.entries.events.EventsResourceWithRawResponse#

class nemo_microservices.resources.intake.entries.entries.EntriesResourceWithStreamingResponse( entries: nemo_microservices.resources.intake.entries.entries.EntriesResource, )#

Initialization

property events: nemo_microservices.resources.intake.entries.events.EventsResourceWithStreamingResponse#

nemo_microservices.resources.intake.entries.entries#

Module Contents#

Classes#

API#

`nemo_microservices.resources.intake.entries.entries`#